/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.webapi.controller;

import static org.hisp.dhis.test.web.WebClientUtils.assertStatus;
import static org.junit.jupiter.api.Assertions.assertEquals;

import org.hisp.dhis.feedback.ErrorCode;
import org.hisp.dhis.jsontree.JsonString;
import org.hisp.dhis.test.web.HttpStatus;
import org.hisp.dhis.test.webapi.H2ControllerIntegrationTestBase;
import org.hisp.dhis.test.webapi.json.domain.JsonGrid;
import org.hisp.dhis.test.webapi.json.domain.JsonWebMessage;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

/**
 * Tests for the {@link EnrollmentAnalyticsController}.
 *
 * <p>The main purpose of this test is not to test the correct business logic but to make sure the
 * controller parameters are recognised correctly.
 *
 * @author Jan Bernitt
 */
class EnrollmentAnalyticsControllerTest extends H2ControllerIntegrationTestBase {

  private String programId;

  private String orgUnitId;

  @BeforeEach
  void setUp() {
    orgUnitId =
        assertStatus(
            HttpStatus.CREATED,
            POST(
                "/organisationUnits/",
                "{'name':'My Unit', 'shortName':'OU1', 'openingDate': '2020-01-01'}"));
    programId =
        assertStatus(
            HttpStatus.CREATED,
            POST(
                "/programs/",
                "{'name':'My Program', 'shortName':'MPX1', 'programType': 'WITHOUT_REGISTRATION', 'organisationUnits': [{'id': '"
                    + orgUnitId
                    + "'}]}"));
  }

  @Test
  @Disabled(
      "generated query will fail on H2 database and we are now propagating BadSqlGrammarException since DHIS2-15184")
  void testGetQueryJson() {
    JsonGrid grid =
        GET(
                "/analytics/enrollments/query/{program}?dimension=ou:{unit}&startDate=2019-01-01&endDate=2021-01-01",
                programId,
                orgUnitId)
            .content()
            .as(JsonGrid.class);
    assertEquals(grid.getHeaderWidth(), grid.getHeaders().size());
    assertEquals(
        "My Program", grid.getMetaData().getItems().get(programId).getString("name").string());
    assertEquals(
        orgUnitId,
        grid.getMetaData().getDimensions().get("ou").get(0).as(JsonString.class).string());
  }

  @Test
  void testBadGrammarException() {
    /* We know this query will fail since it runs on H2 with postgres specific syntax */
    JsonWebMessage jsonWebMessage =
        GET(
                "/analytics/enrollments/query/{program}?dimension=ou:{unit}&startDate=2019-01-01&endDate=2021-01-01",
                programId,
                orgUnitId)
            .content(HttpStatus.CONFLICT)
            .as(JsonWebMessage.class);

    assertEquals("Conflict", jsonWebMessage.getHttpStatus());
    assertEquals(409, jsonWebMessage.getHttpStatusCode());
    assertEquals("ERROR", jsonWebMessage.getStatus());
    assertEquals(
        "Query failed because of a syntax error (SqlState: 90022)", jsonWebMessage.getMessage());
    assertEquals(ErrorCode.E7145, jsonWebMessage.getErrorCode());
  }
}
